Readme update #69
Readme update #69
Conversation
* EI-161 - Defined the Job table schema * EI-161 | removing is_active * EI-161 | Removed extra comma - syntax error * Fixed INTEGRATION typo --------- Co-authored-by: 2omb Finance <2ombfinance@protonmail.com>
* Chore: add Marcos to readme * chore: Add Marcos to readme * Revert "Chore: add Marcos to readme" This reverts commit f9c78c9. * EI-209 Created schedule table on database with attributes based on ERD. * fixed minor ijmport errors and added JPA dependencies to pom.xml file * Revert "fixed minor ijmport errors and added JPA dependencies to pom.xml file" This reverts commit 10425d2. * fixed minor import errors and added JPA dependencies to pom.xml file * chore: add spring test profile disabling auto config for databases * created as commented placeholders for classes that were not implemented yet. * Added sql schedule table script, added lombook @Getter and @Setter support, added JPA @TeMPOraL notation. --------- Signed-off-by: Marcos Pantoja <105100104+Mxrcos13@users.noreply.github.com> Co-authored-by: Caleb Brock <cbrock@csus.edu>
Co-authored-by: Brynn Crowley <littlehill723@gmail.com>
* EI-137: Job Entity Created Job Entity and added necessary dependency to pom.xml * EI-137: Updates to Job Entity Updated entity using lombok getter/setter. Put enums in separate file. Annotated with @TeMPOraL * fix: clean up git merge remains Signed-off-by: Brynn Crowley <littlehill723@gmail.com> * feat: fix controller stub, add entity tests Signed-off-by: Brynn Crowley <littlehill723@gmail.com> * test: add more tests for job entity Signed-off-by: Brynn Crowley <littlehill723@gmail.com> * EI-137 Fixed Build Error Build kept trying to connect to DB causing build fail. Added a test profile to exclude DataSource (similar to whats in main already) --------- Signed-off-by: Brynn Crowley <littlehill723@gmail.com> Co-authored-by: Brynn Crowley <littlehill723@gmail.com>
Built login page UI
cGod778
requested review from
Crowley723,
Mxrcos13,
N-Cooper-100,
OhJino,
cbrock-csus,
dcarello and
tmains515
WalkthroughREADME.md updated with an Entity Relationship Diagram section documenting database entities and their relationships, expanded Overview contextual information about the client and project scope, and enhanced Contributing section with branch naming examples and workflow guidance. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
8-8: Minor: Remove trailing whitespace after closing</div>tag.Line 8 has trailing whitespace that may trigger linting rules. Consider removing it for consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🔇 Additional comments (3)
README.md (3)
11-16: Overview section enhancement looks good.The expansion adds helpful context about the client and project timeline without disrupting the documentation flow.
154-218: Verify database schema relationships and TEST_RESULT entity completeness.The ERD diagram is a solid addition, but two schema elements warrant clarification:
TEST_RESULT entity: Currently has only
result_idandjob_typefields. Is this intentionally minimal (e.g., a base entity in an inheritance hierarchy), or should it include audit fields likecreated_date,updated_date, etc., similar to other entities?Missing JOB → TEST_RESULT relationship: The diagram shows
BATCH_JOBSlinkingJOBtoTEST_BATCH, but there's no explicit relationship betweenJOB(orBATCH_JOBS) andTEST_RESULT. Should there be a relationship indicating that a job generates test results?Please confirm:
- Whether the
TEST_RESULTdefinition is complete and intentional.- Whether a relationship between
JOB/BATCH_JOBSandTEST_RESULTshould be documented.
222-225: Contributing section improvement approved.The added branch naming example (
feature/EI-21) is clear and reinforces the Jira-based workflow described in the guide. This will help contributors follow conventions.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.